Notam Management

System and Message Overviews

Document Version: 2.14

Date: October 2, 2019

Document Revision History

The following revision history table reflects all substantive changes to this document.

Table Of Contents

1 Introduction

This document defines the interfaces which govern the interchange of data between the NOTAM Management system and other systems within an Airline Operation Center (AOC).  Each AOC interface is represented by a message described in an associated XSD (XML Schema Definition). The XSD defines and enforces the required, optional, and conditional data that can be included in a message.

1.1  Audience

The intended audience for this document includes existing and potential Jeppesen customers, integration partners, and personnel with roles associated with application architecture, application development, system testing, implementation, and application support of applications within an Airline Operation Center.

1.2  Scope

This document discusses the Notam Management messages currently supported by the Jeppesen Solution Integrator. Each message description includes the following:

• Overview for common message uses within an AOC
• Message Version Summary listing all available versions of each message
• Links to the message specifications including direct links to XSD documentation, where you can explore the XSD hierarchy and interface specifications in a navigable HTML format
• Links to the XSD source code
• Links to sample XML messages for each AOC message

Other data interfaces or formats not included in this document will be considered custom and not supported.

1.3  XML Schema/XSD

The XML schema for this ICD is published in the following file: NotamManagement.xsd

2  Message Summary

Table 2-1 lists the messages that can be sent or handled by the application. The messages originated by this application (messages that begin with “NM”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

3 AOC Interface Messages

The following messages are processed by the NOTAM Management system.

3.1 NM001 - NOTAM

3.1.1  Message Overview

NOTE: Some versions of the NM001 message do not include XSLs which impacts the ability to crossversion.

The NM001 message versions that do not include XSLs are not used and are not expected to be used in production.

* See the Jeppesen Solution Integrator Configuration Specification (Config Spec) for more information about release cross-versioning compatabilities.
** External customers must consult their Jeppesen representative for more information on release cross-versioning compatabilities.

The NM001 message allows external systems to request a NOTAM data package.  The package can be for a specific flight, or for a generic attributive query.  The message can be set to active, which results in alerts being triggered for new or cancelled NOTAMs that affect the NOTAM search criteria.  The NM001 can also be used to cancel an active query (discontinue alerts).

The NMT has two basic deployment types - single and multi-tenant. Within the xml schema, multi-tenant deployments must use the owner element located in the message header to carry the tenant ID for each unique tenant/customer. Single tenant deployments do not require a tenant ID.

3.1.2  Message System Flow

This message interacts with the systems as shown in Figure 1.

Figure 1. NM001 message system flow

3.1.3   Message Details

The following table provides details on the message version and includes links to the message’s technical specification.

3.2 NM002 - NOTAM Distribution

3.2.1  Message Overview

This message allows the NOTAM Management Tool (NMT) to send outbound notifications (alerts) containing xml NOTAM content based on the ingestion of NOTAMs that match active saved queries in the NMT.  The message can also be used to send outbound logList content for the purposes of reconciliation for a specific active saved query with a downstream system.

3.2.2  Message System Flow

3.2.3   Message Details

The following table provides details on the message version and includes links to the message’s technical specification.

3.3 NM003 - Publish NOTAM

3.3.1  Message Overview

This message allows downstream systems to request individual NOTAM content typically in response to activity driven by the absence of a NOTAM found in a reconciliation logList, or the existence of a NOTAM found in the downstream system, but not present in a reconciliation request logList.

3.3.2  Message System Flow

3.3.3   Message Details

The following table provides details on the message version and includes links to the message's technical specification.